<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 5951 2009-05-18 18:03:10Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left{
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: left }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document">


<blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">File:</th><td class="field-body">opencv.pure</td>
</tr>
<tr class="field"><th class="field-name">Description:</th><td class="field-body">contains manual binding functions, includes external interface</td>
</tr>
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Kay-Uwe Kirstein</td>
</tr>
<tr class="field"><th class="field-name">Version:</th><td class="field-body">0.1</td>
</tr>
</tbody>
</table>
</blockquote>
<!--  -->
<div class="section" id="pure-opencv-pure-bindings-to-computer-vision-library-type-definitions">
<h1>Pure-OpenCV: Pure bindings to Computer Vision Library (Type Definitions)</h1>
<!--  -->
<div class="section" id="pure-function-wrappers">
<h2>Pure function wrappers</h2>
<!--  -->
<div class="section" id="loading-saving-images">
<h3>Loading/Saving Images</h3>
<blockquote>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">cv::LoadImage</span></tt> and <tt class="docutils literal"><span class="pre">cv::SaveImage</span></tt></dt>
<dd><p class="first last">These are wrappers around the functions in the cv::core namespace
and the original OpenCV function <tt class="docutils literal">cvLoadImage</tt> and <tt class="docutils literal">cvSaveImage</tt>. The wrappers maintain a functional
programming style and take care of correct allocation of the image data (at least that's the goal).</p>
</dd>
</dl>
</li>
</ul>
</blockquote>
<!--  -->
</div>
<div class="section" id="cloning-structures">
<h3>Cloning Structures</h3>
<p>These functions perform a direct copy of the respective given structs within Pure without calling
the original c-functions <tt class="docutils literal">cvCloneImage</tt>, <tt class="docutils literal">cvCloneMat</tt>, etc.</p>
<blockquote>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">cv::CloneImage</span> img</tt></dt>
<dd><p class="first last">Returns a new IplImage struct filled with the same data as <tt class="docutils literal">img</tt>
(Implemented as macro for better performance).</p>
</dd>
</dl>
</li>
</ul>
</blockquote>
<!--  -->
<blockquote>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">cv::CloneMat</span> mat</tt></dt>
<dd><p class="first last">Returns a new CvMat struct filled with the same data as <tt class="docutils literal">mat</tt>
(Implemented as macro for better performance).</p>
</dd>
</dl>
</li>
</ul>
</blockquote>
<!--  -->
<blockquote>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">cv::Clone</span> struct</tt></dt>
<dd><p class="first last">Convinience macro to work independent of given struct type
(Includes a case expression and calls the respective <tt class="docutils literal"><span class="pre">cv::CloneXxx</span></tt> macro, internally).</p>
</dd>
</dl>
</li>
</ul>
</blockquote>
<!--  -->
</div>
<div class="section" id="converting-stuctures">
<h3>Converting Stuctures</h3>
<blockquote>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">cv::Matrix</span> img</tt></dt>
<dd><p class="first last">Converts an OpenCV image struct to a Pure matrix (GSL-based).</p>
</dd>
</dl>
</li>
</ul>
</blockquote>
<!--  -->
</div>
<div class="section" id="image-info">
<h3>Image Info</h3>
<p>The following functions return or print out image information, which can also be used for debugging purpose.</p>
<!--  -->
<blockquote>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">cv::DataType</span> img</tt></dt>
<dd><p class="first last">Returns the data type f the given image, as they are defined by OpenCV,
e.g., <tt class="docutils literal"><span class="pre">cv::IPL_DEPTH_8U</span></tt></p>
</dd>
</dl>
</li>
</ul>
</blockquote>
<!--  -->
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">cv::Size</span> img</tt></dt>
<dd><p class="first last">Returns the size of the given img or matrix as tuple <tt class="docutils literal">(rows, cols)</tt>.</p>
</dd>
</dl>
</li>
</ul>
<!--  -->
<blockquote>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">cv::PrintImageInfo</span></tt></dt>
<dd><p class="first last">Prints out a summary of image properties.</p>
</dd>
</dl>
</li>
</ul>
</blockquote>
<!--  -->
</div>
<div class="section" id="general-function-wrapper">
<h3>General Function Wrapper</h3>
<p>These Pure functions provide an interface to the various OpenCV image processing functions.
It hides the handling of dynamic c-structs and their allocation (and deallocation) from the user,
in order to provide a (clean) functional interface. There is a small performance penalty, because
the ommitting of side-effects has to be paid with additional memory allocation. So, if performance
is really critical, the original c-functions are still accessible in the <tt class="docutils literal"><span class="pre">cv::core</span></tt> namespace.
But in this case, one has to make sure, the pointer-arguments are correctly allocated.</p>
<blockquote>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">cv::Apply0</span> fun img</tt></li>
<li><tt class="docutils literal"><span class="pre">cv::Apply1</span> fun img arg1</tt></li>
<li><tt class="docutils literal"><span class="pre">cv::Apply2</span> fun img arg1 arg2</tt></li>
</ul>
</blockquote>
<!--  -->
<blockquote>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">cv::Apply</span> fun img (arg1, ..)</tt>
This is the uncurried version of the function wrapper.</li>
</ul>
</blockquote>
</div>
</div>
</div>
</div>
</body>
</html>
